home *** CD-ROM | disk | FTP | other *** search
/ X User Tools / X User Tools (O'Reilly and Associates)(1994).ISO / sun4c / archive / tcltk.z / tcltk / man / mann / bind.n < prev    next >
Text File  |  1994-09-20  |  22KB  |  635 lines
  1. '\"
  2. '\" Copyright (c) 1990 The Regents of the University of California.
  3. '\" All rights reserved.
  4. '\"
  5. '\" Permission is hereby granted, without written agreement and without
  6. '\" license or royalty fees, to use, copy, modify, and distribute this
  7. '\" documentation for any purpose, provided that the above copyright
  8. '\" notice and the following two paragraphs appear in all copies.
  9. '\"
  10. '\" IN NO EVENT SHALL THE UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY
  11. '\" FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
  12. '\" ARISING OUT OF THE USE OF THIS DOCUMENTATION, EVEN IF THE UNIVERSITY OF
  13. '\" CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  14. '\"
  15. '\" THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY WARRANTIES,
  16. '\" INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
  17. '\" AND FITNESS FOR A PARTICULAR PURPOSE.  THE SOFTWARE PROVIDED HEREUNDER IS
  18. '\" ON AN "AS IS" BASIS, AND THE UNIVERSITY OF CALIFORNIA HAS NO OBLIGATION TO
  19. '\" PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
  20. '\" 
  21. '\" $Header: /user6/ouster/wish/man/RCS/bind.n,v 1.20 93/08/20 08:37:02 ouster Exp $ SPRITE (Berkeley)
  22. '/" 
  23. .\" The definitions below are for supplemental macros used in Tcl/Tk
  24. .\" manual entries.
  25. .\"
  26. .\" .HS name section [date [version]]
  27. .\"    Replacement for .TH in other man pages.  See below for valid
  28. .\"    section names.
  29. .\"
  30. .\" .AP type name in/out [indent]
  31. .\"    Start paragraph describing an argument to a library procedure.
  32. .\"    type is type of argument (int, etc.), in/out is either "in", "out",
  33. .\"    or "in/out" to describe whether procedure reads or modifies arg,
  34. .\"    and indent is equivalent to second arg of .IP (shouldn't ever be
  35. .\"    needed;  use .AS below instead)
  36. .\"
  37. .\" .AS [type [name]]
  38. .\"    Give maximum sizes of arguments for setting tab stops.  Type and
  39. .\"    name are examples of largest possible arguments that will be passed
  40. .\"    to .AP later.  If args are omitted, default tab stops are used.
  41. .\"
  42. .\" .BS
  43. .\"    Start box enclosure.  From here until next .BE, everything will be
  44. .\"    enclosed in one large box.
  45. .\"
  46. .\" .BE
  47. .\"    End of box enclosure.
  48. .\"
  49. .\" .VS
  50. .\"    Begin vertical sidebar, for use in marking newly-changed parts
  51. .\"    of man pages.
  52. .\"
  53. .\" .VE
  54. .\"    End of vertical sidebar.
  55. .\"
  56. .\" .DS
  57. .\"    Begin an indented unfilled display.
  58. .\"
  59. .\" .DE
  60. .\"    End of indented unfilled display.
  61. .\"
  62. '\"    # Heading for Tcl/Tk man pages
  63. .de HS
  64. .ds ^3 \\0
  65. .if !"\\$3"" .ds ^3 \\$3
  66. .if '\\$2'cmds'       .TH \\$1 1 \\*(^3 \\$4
  67. .if '\\$2'lib'        .TH \\$1 3 \\*(^3 \\$4
  68. .if '\\$2'tcl'        .TH \\$1 n \\*(^3 Tcl "Tcl Built-In Commands"
  69. .if '\\$2'tk'         .TH \\$1 n \\*(^3 Tk "Tk Commands"
  70. .if '\\$2'tclc'        .TH \\$1 3 \\*(^3 Tcl "Tcl Library Procedures"
  71. .if '\\$2'tkc'         .TH \\$1 3 \\*(^3 Tk "Tk Library Procedures"
  72. .if '\\$2'tclcmds'         .TH \\$1 1 \\*(^3 Tk "Tcl Applications"
  73. .if '\\$2'tkcmds'         .TH \\$1 1 \\*(^3 Tk "Tk Applications"
  74. .if t .wh -1.3i ^B
  75. .nr ^l \\n(.l
  76. .ad b
  77. ..
  78. '\"    # Start an argument description
  79. .de AP
  80. .ie !"\\$4"" .TP \\$4
  81. .el \{\
  82. .   ie !"\\$2"" .TP \\n()Cu
  83. .   el          .TP 15
  84. .\}
  85. .ie !"\\$3"" \{\
  86. .ta \\n()Au \\n()Bu
  87. \&\\$1    \\fI\\$2\\fP    (\\$3)
  88. .\".b
  89. .\}
  90. .el \{\
  91. .br
  92. .ie !"\\$2"" \{\
  93. \&\\$1    \\fI\\$2\\fP
  94. .\}
  95. .el \{\
  96. \&\\fI\\$1\\fP
  97. .\}
  98. .\}
  99. ..
  100. '\"    # define tabbing values for .AP
  101. .de AS
  102. .nr )A 10n
  103. .if !"\\$1"" .nr )A \\w'\\$1'u+3n
  104. .nr )B \\n()Au+15n
  105. .\"
  106. .if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n
  107. .nr )C \\n()Bu+\\w'(in/out)'u+2n
  108. ..
  109. '\"    # BS - start boxed text
  110. '\"    # ^y = starting y location
  111. '\"    # ^b = 1
  112. .de BS
  113. .br
  114. .mk ^y
  115. .nr ^b 1u
  116. .if n .nf
  117. .if n .ti 0
  118. .if n \l'\\n(.lu\(ul'
  119. .if n .fi
  120. ..
  121. '\"    # BE - end boxed text (draw box now)
  122. .de BE
  123. .nf
  124. .ti 0
  125. .mk ^t
  126. .ie n \l'\\n(^lu\(ul'
  127. .el \{\
  128. .\"    Draw four-sided box normally, but don't draw top of
  129. .\"    box if the box started on an earlier page.
  130. .ie !\\n(^b-1 \{\
  131. \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
  132. .\}
  133. .el \}\
  134. \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
  135. .\}
  136. .\}
  137. .fi
  138. .br
  139. .nr ^b 0
  140. ..
  141. '\"    # VS - start vertical sidebar
  142. '\"    # ^Y = starting y location
  143. '\"    # ^v = 1 (for troff;  for nroff this doesn't matter)
  144. .de VS
  145. .mk ^Y
  146. .ie n 'mc \s12\(br\s0
  147. .el .nr ^v 1u
  148. ..
  149. '\"    # VE - end of vertical sidebar
  150. .de VE
  151. .ie n 'mc
  152. .el \{\
  153. .ev 2
  154. .nf
  155. .ti 0
  156. .mk ^t
  157. \h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n'
  158. .sp -1
  159. .fi
  160. .ev
  161. .\}
  162. .nr ^v 0
  163. ..
  164. '\"    # Special macro to handle page bottom:  finish off current
  165. '\"    # box/sidebar if in box/sidebar mode, then invoked standard
  166. '\"    # page bottom macro.
  167. .de ^B
  168. .ev 2
  169. 'ti 0
  170. 'nf
  171. .mk ^t
  172. .if \\n(^b \{\
  173. .\"    Draw three-sided box if this is the box's first page,
  174. .\"    draw two sides but no top otherwise.
  175. .ie !\\n(^b-1 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
  176. .el \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
  177. .\}
  178. .if \\n(^v \{\
  179. .nr ^x \\n(^tu+1v-\\n(^Yu
  180. \kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c
  181. .\}
  182. .bp
  183. 'fi
  184. .ev
  185. .if \\n(^b \{\
  186. .mk ^y
  187. .nr ^b 2
  188. .\}
  189. .if \\n(^v \{\
  190. .mk ^Y
  191. .\}
  192. ..
  193. '\"    # DS - begin display
  194. .de DS
  195. .RS
  196. .nf
  197. .sp
  198. ..
  199. '\"    # DE - end display
  200. .de DE
  201. .fi
  202. .RE
  203. .sp .5
  204. ..
  205. .HS bind tk
  206. .BS
  207. '\" Note:  do not modify the .SH NAME line immediately below!
  208. .SH NAME
  209. bind \- Arrange for X events to invoke Tcl commands
  210. .SH SYNOPSIS
  211. \fBbind\fI windowSpec\fR
  212. .br
  213. \fBbind\fI windowSpec sequence\fR
  214. .br
  215. \fBbind\fI windowSpec sequence command\fR
  216. .br
  217. \fBbind\fI windowSpec sequence \fB+\fIcommand\fR
  218. .BE
  219.  
  220. .SH DESCRIPTION
  221. .PP
  222. If all three arguments are specified, \fBbind\fR will
  223. arrange for \fIcommand\fR (a Tcl
  224. command) to be executed whenever the sequence of events given
  225. .VS
  226. by \fIsequence\fR occurs in the window(s) identified by \fIwindowSpec\fR.
  227. .VE
  228. If \fIcommand\fR is prefixed with a ``+'', then it is appended to
  229. any existing binding for \fIsequence\fR;  otherwise \fIcommand\fR replaces
  230. the existing binding, if any.  If \fIcommand\fR
  231. is an empty string then the current binding for \fIsequence\fR
  232. is destroyed, leaving \fIsequence\fR unbound.  In all of the cases
  233. where a \fIcommand\fR argument is provided, \fBbind\fR returns
  234. an empty string.
  235. .PP
  236. If \fIsequence\fR is specified without a \fIcommand\fR, then the
  237. command currently bound to \fIsequence\fR is returned, or
  238. an empty string if there is no binding for \fIsequence\fR.  If
  239. neither \fIsequence\fR nor \fIcommand\fR is specified, then the
  240. return value is a list whose elements are all the sequences
  241. .VS
  242. for which there exist bindings for \fIwindowSpec\fR.
  243. .PP
  244. The \fIwindowSpec\fR argument selects which window(s) the binding
  245. applies to.
  246. It may have one of three forms.
  247. If \fIwindowSpec\fR is the path name for a window, then the binding
  248. applies to that particular window.
  249. If \fIwindowSpec\fR is the name of a class of widgets, then the
  250. binding applies to all widgets in that class.
  251. Lastly, \fIwindowSpec\fR may have the value \fBall\fR, in which case
  252. the binding applies to all windows in the application.
  253. .VE
  254. .PP
  255. The \fIsequence\fR argument specifies a sequence of one or more
  256. event patterns, with optional white space between the patterns.  Each
  257. event pattern may
  258. take either of two forms.  In the simplest case it is a single
  259. printing ASCII character, such as \fBa\fR or \fB[\fR.  The character
  260. may not be a space character or the character \fB<\fR.  This form of
  261. pattern matches a \fBKeyPress\fR event for the particular
  262. character.  The second form of pattern is longer but more general.
  263. It has the following syntax:
  264. .DS C
  265. \fB<\fImodifier-modifier-type-detail\fB>\fR
  266. .DE
  267. The entire event pattern is surrounded by angle brackets.
  268. Inside the angle brackets are zero or more modifiers, an event
  269. type, and an extra piece of information (\fIdetail\fR) identifying
  270. a particular button or keysym.  Any of the fields may be omitted,
  271. as long as at least one of \fItype\fR and \fIdetail\fR is present.
  272. The fields must be separated by white space or dashes.
  273. .LP
  274. Modifiers may consist of any of the values in the following list:
  275. .DS
  276. .ta 6c
  277. \fBControl\fR    \fBAny\fR
  278. \fBShift\fR    \fBDouble\fR    
  279. \fBLock\fR    \fBTriple\fR
  280. .VS
  281. \fBButton1, B1\fR    \fBMod1, M1, Meta, M\fR    
  282. \fBButton2, B2\fR    \fBMod2, M2, Alt\fR
  283. .VE
  284. \fBButton3, B3\fR    \fBMod3, M3\fR
  285. \fBButton4, B4\fR    \fBMod4, M4\fR
  286. \fBButton5, B5\fR    \fBMod5, M5\fR
  287. .DE
  288. Where more than one value is listed, separated by commas, the values
  289. are equivalent.   All of the modifiers except \fBAny\fR,
  290. \fBDouble\fR, and \fBTriple\fR have
  291. the obvious X meanings.  For example, \fBButton1\fR requires that
  292. button 1 be depressed when the event occurs.  Under normal conditions
  293. the button and modifier state at the time of the event must
  294. match exactly those specified in the \fBbind\fR command.  If
  295. no modifiers are specified, then events will match only if no modifiers
  296. are present.  If the \fBAny\fR modifier is specified, then additional
  297. modifiers may be present besides those specified explicitly.  For
  298. example, if button 1 is pressed while the shift and control keys
  299. are down, the specifier \fB<Any-Control-Button-1>\fR will match
  300. the event, but the specifier \fB<Control-Button-1>\fR will not.
  301. .LP
  302. The \fBDouble\fR and \fBTriple\fR modifiers are a convenience
  303. for specifying double mouse clicks and other repeated
  304. events. They cause a particular event pattern to be
  305. repeated 2 or 3 times, and also place a time and space requirement
  306. on the sequence:  for a sequence of events to match a \fBDouble\fR
  307. or \fBTriple\fR pattern, all of the events must occur close together
  308. in time and without substantial mouse motion in between.
  309. For example, \fB<Double-Button-1>\fR
  310. is equivalent to \fB<Button-1><Button-1>\fR with the extra
  311. time and space requirement.
  312. .LP
  313. The \fItype\fR field may be any of the standard X event types, with a
  314. few extra abbreviations.  Below is a list of all the valid types;
  315. where two name appear together, they are synonyms.
  316. .DS C
  317. .ta 5c 10c
  318. \fBButtonPress, Button    Expose    Leave
  319. ButtonRelease    FocusIn    Map
  320. Circulate    FocusOut    Property
  321. CirculateRequest    Gravity    Reparent
  322. Colormap    Keymap    ResizeRequest
  323. Configure    KeyPress, Key    Unmap
  324. .VS
  325. .VE
  326. ConfigureRequest    KeyRelease    Visibility
  327. Destroy    MapRequest
  328. Enter    Motion\fR
  329. .DE
  330. .LP
  331. The last part of a long event specification is \fIdetail\fR.  In the
  332. case of a \fBButtonPress\fR or \fBButtonRelease\fR event, it is the
  333. number of a button (1-5).  If a button number is given, then only an
  334. event on that particular button will match;  if no button number is
  335. given, then an event on any button will match.  Note:  giving a
  336. specific button number is different than specifying a button modifier;
  337. in the first case, it refers to a button being pressed or released,
  338. while in the second it refers to some other button that is already
  339. depressed when the matching event occurs.  If a button
  340. number is given then \fItype\fR may be omitted:  if will default
  341. to \fBButtonPress\fR.  For example, the specifier \fB<1>\fR
  342. is equivalent to \fB<ButtonPress-1>\fR.
  343. .LP
  344. If the event type is \fBKeyPress\fR or \fBKeyRelease\fR, then
  345. \fIdetail\fR may be specified in the form of an X keysym.  Keysyms
  346. are textual specifications for particular keys on the keyboard;
  347. they include all the alphanumeric ASCII characters (e.g. ``a'' is
  348. the keysym for the ASCII character ``a''), plus descriptions for
  349. non-alphanumeric characters (``comma'' is the keysym for the comma
  350. character), plus descriptions for all the non-ASCII keys on the
  351. keyboard (``Shift_L'' is the keysm for the left shift key, and
  352. ``F1'' is the keysym for the F1 function key, if it exists).  The
  353. complete list of keysyms is not presented here;  it should be
  354. available in other X documentation.  If necessary, you can use the
  355. \fB%K\fR notation described below to print out the keysym name for
  356. an arbitrary key.  If a keysym \fIdetail\fR is given, then the
  357. \fItype\fR field may be omitted;  it will default to \fBKeyPress\fR.
  358. For example, \fB<Control-comma>\fR is equivalent to
  359. \fB<Control-KeyPress-comma>\fR.  If a keysym \fIdetail\fR is specified
  360. then the \fBShift\fR modifier need not be specified and will be
  361. ignored if specified:  each keysym already implies a particular
  362. state for the shift key.
  363. .LP
  364. The \fIcommand\fR argument to \fBbind\fR is a Tcl command string,
  365. which will be executed whenever the given event sequence occurs.
  366. \fICommand\fR will be executed in the same interpreter that the
  367. \fBbind\fR command was executed in.  If \fIcommand\fR contains
  368. any \fB%\fR characters, then the command string will not be
  369. executed directly.  Instead, a new command string will be
  370. generated by replacing each \fB%\fR, and the character following
  371. it, with information from the current event.  The replacement
  372. depends on the character following the \fB%\fR, as defined in the
  373. list below.  Unless otherwise indicated, the
  374. .VS
  375. replacement string is the decimal value of the given field from
  376. the current event.
  377. .VE
  378. Some of the substitutions are only valid for
  379. certain types of events;  if they are used for other types of events
  380. the value substituted is undefined.
  381. .TP
  382. \fB%%\fR
  383. Replaced with a single percent.
  384. .TP
  385. \fB%#\fR
  386. The number of the last client request processed by the server
  387. (the \fIserial\fR field from the event).  Valid for all event
  388. types.
  389. .TP
  390. \fB%a\fR
  391. The \fIabove\fR field from the event.
  392. Valid only for \fBConfigureNotify\fR events.
  393. .TP
  394. \fB%b\fR
  395. The number of the button that was pressed or released.  Valid only
  396. for \fBButtonPress\fR and \fBButtonRelease\fR events.
  397. .TP
  398. \fB%c\fR
  399. The \fIcount\fR field from the event.  Valid only for \fBExpose\fR,
  400. \fBGraphicsExpose\fR, and \fBMappingNotify\fR events.
  401. .TP
  402. \fB%d\fR
  403. The \fIdetail\fR field from the event.  The \fB%d\fR is replaced by
  404. a string identifying the detail.  For \fBEnterNotify\fR,
  405. \fBLeaveNotify\fR, \fBFocusIn\fR, and \fBFocusOut\fR events,
  406. the string will be one of the following:
  407. .RS
  408. .DS
  409. .ta 6c
  410. \fBNotifyAncestor    NotifyNonlinearVirtual
  411. NotifyDetailNone    NotifyPointer
  412. NotifyInferior    NotifyPointerRoot
  413. NotifyNonlinear    NotifyVirtual\fR
  414. .DE
  415. For \fBConfigureRequest\fR events, the substituted string will be
  416. one of the following:
  417. .DS
  418. .ta 6c
  419. \fBAbove    Opposite
  420. Below    TopIf
  421. BottomIf\fR
  422. .DE
  423. For events other than these, the substituted string is undefined.
  424. .RE
  425. .TP
  426. \fB%f\fR
  427. The \fIfocus\fR field from the event (\fB0\fR or \fB1\fR).  Valid only
  428. for \fBEnterNotify\fR and \fBLeaveNotify\fR events.
  429. .TP
  430. \fB%h\fR
  431. The \fIheight\fR field from the event.  Valid only for \fBConfigure\fR,
  432. \fBConfigureNotify\fR, \fBExpose\fR, \fBGraphicsExpose\fR, and
  433. \fBResizeRequest\fR events.
  434. .TP
  435. \fB%k\fR
  436. The \fIkeycode\fR field from the event.  Valid only for \fBKeyPress\fR
  437. and \fBKeyRelease\fR events.
  438. .TP
  439. \fB%m\fR
  440. The \fImode\fR field from the event.  The substituted string is one of
  441. \fBNotifyNormal\fR, \fBNotifyGrab\fR, \fBNotifyUngrab\fR, or
  442. \fBNotifyWhileGrabbed\fR.  Valid only for \fBEnterWindow\fR,
  443. \fBFocusIn\fR, \fBFocusOut\fR, and \fBLeaveWindow\fR events.
  444. .TP
  445. \fB%o\fR
  446. The \fIoverride_redirect\fR field from the event.  Valid only for
  447. \fBCreateNotify\fR, \fBMapNotify\fR, \fBReparentNotify\fR,
  448. and \fBConfigureNotify\fR events.
  449. .TP
  450. \fB%p\fR
  451. The \fIplace\fR field from the event, substituted as one of the
  452. strings \fBPlaceOnTop\fR or \fBPlaceOnBottom\fR.  Valid only
  453. for \fBCirculateNotify\fR and \fBCirculateRequest\fR events.
  454. .TP
  455. \fB%s\fR
  456. The \fIstate\fR field from the event.  For \fBButtonPress\fR,
  457. \fBButtonRelease\fR, \fBEnterNotify\fR, \fBKeyPress\fR, \fBKeyRelease\fR,
  458. \fBLeaveNotify\fR, and \fBMotionNotify\fR events,
  459. .VS
  460. a decimal string
  461. .VE
  462. is substituted.  For \fBVisibilityNotify\fR, one of the strings
  463. \fBVisibilityUnobscured\fR, \fBVisibilityPartiallyObscured\fR,
  464. and \fBVisibilityFullyObscured\fR is substituted.
  465. .TP
  466. \fB%t\fR
  467. The \fItime\fR field from the event.  Valid only for events that
  468. contain a \fItime\fR field.
  469. .TP
  470. \fB%v\fR
  471. The \fIvalue_mask\fR field from the event.  Valid only for
  472. \fBConfigureRequest\fR events.
  473. .TP
  474. \fB%w\fR
  475. The \fIwidth\fR field from the event.  Valid only for
  476. \fBConfigure\fR, \fBConfigureRequest\fR, \fBExpose\fR,
  477. \fBGraphicsExpose\fR, and \fBResizeRequest\fR events.
  478. .TP
  479. \fB%x\fR
  480. The \fIx\fR field from the event.  Valid only for events containing
  481. an \fIx\fR field.
  482. .TP
  483. \fB%y\fR
  484. The \fIy\fR field from the event.  Valid only for events containing
  485. a \fIy\fR field.
  486. .TP
  487. \fB%A\fR
  488. Substitutes the ASCII character corresponding to the event, or
  489. the empty string if the event doesn't correspond to an ASCII character
  490. (e.g. the shift key was pressed).  \fBXLookupString\fR does all the
  491. work of translating from the event to an ASCII character.
  492. Valid only for \fBKeyPress\fR and \fBKeyRelease\fR events.
  493. .TP
  494. \fB%B\fR
  495. The \fIborder_width\fR field from the event.  Valid only for
  496. \fBConfigureNotify\fR and \fBCreateWindow\fR events.
  497. .TP
  498. \fB%D\fR
  499. The \fIdisplay\fR field from the event.  Valid for all event types.
  500. .TP
  501. \fB%E\fR
  502. The \fIsend_event\fR field from the event.  Valid for all event types.
  503. .TP
  504. \fB%K\fR
  505. The keysym corresponding to the event, substituted as a textual
  506. string.  Valid only for \fBKeyPress\fR and \fBKeyRelease\fR events.
  507. .TP
  508. \fB%N\fR
  509. The keysym corresponding to the event, substituted as
  510. .VS
  511. a decimal
  512. .VE
  513. number.  Valid only for \fBKeyPress\fR and \fBKeyRelease\fR events.
  514. .TP
  515. \fB%R\fR
  516. The \fIroot\fR window identifier from the event.  Valid only for
  517. events containing a \fIroot\fR field.
  518. .TP
  519. \fB%S\fR
  520. The \fIsubwindow\fR window identifier from the event.  Valid only for
  521. events containing a \fIsubwindow\fR field.
  522. .TP
  523. \fB%T\fR
  524. The \fItype\fR field from the event.  Valid for all event types.
  525. .TP
  526. \fB%W\fR
  527. The path name of the window to which the event was reported (the
  528. \fIwindow\fR field from the event).  Valid for all event types.
  529. .TP
  530. \fB%X\fR
  531. The \fIx_root\fR field from the event.
  532. .VS
  533. If a virtual-root window manager is being used then the substituted
  534. value is the corresponding x-coordinate in the virtual root.
  535. .VE
  536. Valid only for
  537. \fBButtonPress\fR, \fBButtonRelease\fR, \fBKeyPress\fR, \fBKeyRelease\fR,
  538. and \fBMotionNotify\fR events.
  539. .TP
  540. \fB%Y\fR
  541. The \fIy_root\fR field from the event.
  542. .VS
  543. If a virtual-root window manager is being used then the substituted
  544. value is the corresponding y-coordinate in the virtual root.
  545. .VE
  546. Valid only for
  547. \fBButtonPress\fR, \fBButtonRelease\fR, \fBKeyPress\fR, \fBKeyRelease\fR,
  548. and \fBMotionNotify\fR events.
  549. .LP
  550. If the replacement string
  551. .VS
  552. for a %-replacement contains characters that are interpreted
  553. specially by the Tcl parser (such as backslashes or square
  554. brackets or spaces) additional backslashes are added
  555. during replacement so that the result after parsing is the original
  556. replacement string.
  557. For example, if \fIcommand\fR is
  558. .DS
  559. \fBinsert\0%A\fR
  560. .DE
  561. and the character typed is an open square bracket, then the command
  562. actually executed will be
  563. .DS
  564. \fBinsert\0\e[\fR
  565. .DE
  566. This will cause the \fBinsert\fR to receive the original replacement
  567. string (open square bracket) as its first argument.
  568. If the extra backslash hadn't been added, Tcl would not have been
  569. able to parse the command correctly.
  570. .VE
  571. .LP
  572. At most one binding will trigger for any given X event.
  573. If several bindings match the recent events, the most specific binding
  574. is chosen and its command will be executed.
  575. The following tests are applied, in order, to determine which of
  576. several matching sequences is more specific:
  577. .VS
  578. (a) a binding whose \fIwindowSpec\fR names a particular window is
  579. more specific than a binding for a class,
  580. which is more specific than a binding whose \fIwindowSpec\fR is
  581. \fBall\fR;
  582. .VE
  583. (b) a longer sequence (in terms of number
  584. of events matched) is more specific than a shorter sequence;
  585. (c) an event pattern that specifies a specific button or key is more specific
  586. than one that doesn't;  (e) an event pattern that requires a particular
  587. modifier is more specific than one that doesn't require the modifier;
  588. (e) an event pattern specifying the \fBAny\fR modifier is less specific
  589. than one that doesn't.  If the matching sequences contain more than
  590. one event, then tests (c)-(e) are applied in order from the most
  591. recent event to the least recent event in the sequences.  If these
  592. tests fail to determine a winner, then the most recently registered
  593. sequence is the winner.
  594. .LP
  595. If an X event does not match any of the existing bindings, then the
  596. event is ignored (an unbound event is not considered to be an error).
  597. .LP
  598. When a \fIsequence\fR specified in a \fBbind\fR command contains
  599. more than one event pattern, then its command is executed whenever
  600. the recent events (leading up to and including the current event)
  601. match the given sequence.  This means, for example, that if button 1 is
  602. clicked repeatedly the sequence \fB<Double-ButtonPress-1>\fR will match
  603. each button press but the first.
  604. .VS
  605. If extraneous events that would prevent a match occur in the middle
  606. of an event sequence then the extraneous events are
  607. ignored unless they are \fBKeyPress\fR or \fBButtonPress\fR events.
  608. For example, \fB<Double-ButtonPress-1>\fR will match a sequence of
  609. presses of button 1, even though there will be \fBButtonRelease\fR
  610. events (and possibly \fBMotionNotify\fR events) between the
  611. \fBButtonPress\fR events.
  612. Furthermore, a \fBKeyPress\fR event may be preceded by any number
  613. of other \fBKeyPress\fR events for modifier keys without the
  614. modifier keys preventing a match.
  615. For example, the event sequence \fBaB\fR will match a press of the
  616. \fBa\fR key, a release of the \fBa\fR key, a press of the \fBShift\fR
  617. key, and a press of the \fBb\fR key:  the press of \fBShift\fR is
  618. ignored because it is a modifier key.
  619. .VE
  620. Finally, if several \fBMotionNotify\fR events occur in a row, only
  621. the last one is used for purposes of matching binding sequences.
  622. .LP
  623. If an error occurs in executing the command for a binding then the
  624. \fBtkerror\fR mechanism is used to report the error.
  625. .VS
  626. The command will be executed at global level (outside the context
  627. of any Tcl procedure).
  628. .VE
  629.  
  630. .SH "SEE ALSO"
  631. tkerror
  632.  
  633. .SH KEYWORDS
  634. form, manual
  635.